Configure Earn Rule Properties

To configure the properties of an Earn Rule:

  1. Select Rules from the top navigation bar, then select Earn Rules from the side navigation menu. The Earn Rules screen is displayed.

  2. Optionally, search for the desired Earn Rule (see Search for an Earn Rule for more information on the available search options).

  3. Optionally, expand an Earn Rule Group by clicking the Expand icon next to its name.

  4. Next to the desired Earn Rule, click the Edit icon. The Edit Earn Rule tabbed modal is displayed.

  1. The Edit Earn Rule modal is split into multiple tabs. Select the desired tab and enter the desired configuration options. See below for details on these tabs, and the options available in each.

  2. Optionally, click Next to save your changes and display the next tab in the sequence.

Note: When you attempt to navigate to a new tab, the platform evaluates the information on the current tab. If any information is invalid or missing, an error message is displayed.

  1. When finished, click Close (or click Save Configuration on the Status & Effectivity tab).

Basic Information

The Basic Information tab displays the high-level properties of the Earn Rule. To configure these properties:

  1. Select the Basic Information tab.

  2. In the Display Name field, enter the name of the Earn Rule.

  3. The Internal Name is automatically populated based on the Display Name value. This field is not editable by default. To edit the Internal Name, check Edit Internal Name. A confirmation dialog box is displayed; click Ok. Edit the Internal Name value.

  4. Optionally, in the Description field, enter a description of this item.

  5. From the Rule Grouping drop-down menu, select the Earn Rule Group to which you want to assign this Earn Rule.

  6. Click into the Activity Type field, then select the Activity Type that this Earn Rule will "listen" for. When a Member performs the selected Activity Type, the Earn Rule executes. Repeat this step as needed to select multiple Activity Types.

  7. From the Metric drop-down menu, select the Member Metric that this Earn Rule will calculate when a Member performs the selected Activity Type.

  1. Select the Metric expiration method utilized by this Earn Rule:

    • Default Expiration: The Earn Rule uses the default Metric expiration method defined for your account. For more information, see the Point Expiration User Guide.

    • Variable Expiration: The Earn Rule uses a custom Metric expiration method. Select one of the following:

      • Expiration Period: Metrics expire after a specified period of time from when they are earned. Enter a number and select a unit (Days, Months, or Years) to define the expiration period. For example, "6 Months."

      • Specific Date: Metrics expire on a specified date, regardless of when they are earned. Click into the date field, and select the date from the calendar pop-up.

Conditions & Expressions

The Conditions & Expressions tab is used to define the conditions for the Earn Rule. An Earn Rule will execute only if the conditions are met.

Note: The use of conditions in an Earn Rule is optional. If a condition is not defined, the Earn Rule is assumed to always apply whenever a Member performs the assigned Activity Type.

A condition consists of one or more logical statements (called Rules) joined with logical operators (AND / OR). An Earn Rule can optionally include multiple conditions.

To define the conditions for an Earn Rule:

  1. Select the Conditions & Expression tab.

  2. Click Add Condition.

  3. Click the Add icon, then select Add Rule. The platform adds a new blank row. 

  1. The first drop-down menu is populated with all of the different object types in Loyalty that are available for use. From this drop-down menu, select one of the following object types to expand it and see the available options:

This option allows you to define a logical statement based on a value in a Member Attribute.

  1. From the menu, select the desired Member Attribute.

  2. Select a mathematical operator; the available operators will vary based on the Data Type of the item you selected above. 

  3. Enter or select a value. 

This option allows you to define a logical statement based on a value in a Member Preference.

  1. From the menu, select the desired Member Preference.

  2. Select a mathematical operator. 

  3. Enter or select a value. 

This option allows you to define a logical statement by performing a mathematical calculation on a selected Activity Type.

  1. From the menu, select the desired calculation method: Aggregate, Count, or Recency.

  2. From the second drop-down menu, select the desired Activity Type.

  3. Select a mathematical operator. 

  4. Enter or select a value. 

  5. Based on the selected calculation method, the platform provides the option to enter additional criteria:

    • Count: Define a time period, such as "Is In Last 3 Months." The use of a time period is optional, but recommended to improve system performance.

    • Aggregate: Select how to perform the aggregation: either by picking an Attribute on which to aggregate, or by entering a Groovy expression. Select the Aggregate Function: Sum, Minimum, or Maximum. Define a time period, such as "Is In Last 3 Months." The use of a time period is optional, but recommended to improve system performance.

This option allows you to define a logical statement using a Member's history of Metric usage.

  1. From the menu, select the desired usage type: Balance, Earn, Expire, or Redeem.

  2. From the second drop-down menu, select the desired Metric.

  3. Select a mathematical operator. 

  4. Enter or select a value. 

  5. For the Earn, Expire, and Redeem Metric usage types, define a time period, such as "Is In Last 3 Months." The use of a time period is optional, but recommended to improve system performance.

This option allows you to define a logical statement by referencing either a Lookup table or a Member Function.

  1. From the menu, select either Lookup or Function.

  2. From the second drop-down menu, select the desired Lookup table or Member Function.

  3. Select a mathematical operator. 

  4. Enter or select a value. 

  5. If you selected a Lookup table and it has Parameters defined, select the Attribute on which to match.

  6. If you selected a Member Function and it has Arguments defined, select the Attribute on which to match.

This option allows you to define a logical statement using a Groovy expression.

  1. From the menu, select Advanced Expression.

  2. In the code editor field, enter the desired Groovy expression.

This option allows you to define a logical statement by referencing a Custom Object.

  1. From the menu, select either the desired Custom Object.

  2. Select a mathematical operator. 

  3. Enter or select a value. 

  4. Optionally, define a Condition that limits what records from the Custom Object are included.

 

  1. Repeat the above steps as needed to define more Rules. Optionally, to delete a Rule, click the Delete icon next to it.

  2. Once you define more than one Rule, select the logical operator from the Include customers that meet drop-down menu: 

    • All of the following: Use an 'AND' operator such that all Rules must be true for a record to be selected. 

    • Some of the following: Use an 'OR' operator such that at least one of the Rules must be true for a record to be selected.

  3. Optionally, you can also organize Rules into Rule Groups. A Rule Group allows you to build more complex selection criteria. To create a Rule Group, click the Add icon, then select Add Rule Group. The platform creates a Group, which is represented visually as a nested box with its own operator and Add icon. Within this Group box, click the Add icon to define the Rule (or Rules) using the same process as described above. Use the toggle within the Group box to define the logical operator for the Rules within the Group. To delete an entire Rule Group, click the Delete icon just above the nested box representing the Group.

Note: By clicking the Group button inside the Group box, you can create "nested" groups.

  1. As you define Rules through the user interface, the platform builds a Groovy expression. To see this Groovy Expression, click Show Expression. The Show Expression pop-up window is displayed. When finished, click Close.

  2. Optionally, to delete a condition, click Remove Condition.

  3. Optionally, to define another condition, click Add Condition and repeat the above steps. Multiple conditions are always joined with an AND operator.

Calculation & Settings

The calculation for an Earn Rule represents the mathematical formula for determining the Metric adjustment when a Member performs the selected Activity Type (and if the condition is met).

Note: Defining the calculation requires knowledge of the Groovy programming language.  To assist with writing Groovy expressions, the platform provides a built-in evaluation tool. See Evaluate Earn Rules Expression for more information.

To define the calculation for an Earn Rule:

  1. Select the Calculation & Settings tab.

  1.  Next to Authoring Mode, select Expression.

Note: The Template Authoring Mode has been deprecated, and is no longer supported.

  1. In the Expression field, enter a Groovy expression.

  2. Optionally, click Validate Expression to validate the Groovy code. A message is displayed, indicating the results of the validation.

Status & Effectivity

The Status & Effectivity tab allows you to set the Earn Rule status, and to define when, and for how long, the Earn Rule is considered live and usable.

To set the Earn Rule’s status:

  1. Select the Status & Effectivity tab.

  2. From the Status drop-down menu, select the status of the Earn Rule: Draft, Published, or Archived.

To set the Earn Rule’s effectivity period:

  1. Select the Status & Effectivity tab.

  2. Next to Effectivity, select either:

    • Always: This Earn Rule doesn't expire.

    • Scheduled: Enter a start date and end date, and select a time zone. Optionally, check Recurring to use a recurring schedule. Select the desired schedule from the Recurring Schedule drop-down menu, or define a new recurring schedule (see below for details on that process).

Recurring Schedule

To define a new recurring schedule:

  1. From the Recurring Schedule drop down menu, select Enter Schedule. The Repeat pop-up window is displayed.

  2. From the Count drop-down menu, select a recurrence frequency of either Weekly or Monthly.

  3. In the text field, enter the interval. Enter 1 if you want the schedule to run every week, or every month.

  4. For a Weekly frequency, select one or more days of the week. For example, Tuesdays and Thursdays.

  5. For a Monthly frequency, choose one of the following options:

    • Day of month: Select one or more days of the month. For example, the 15th and the 30th.

    • Day of week: Select one or more days of the week, for each of the four weeks within a month. For example, the second Wednesday of the month.

  1. Click Confirm. The system adds the new schedule to the Recurring Schedule drop-down menu.